CropperJS is a JavaScript library that provides a simple and easy-to-use interface for cropping images. It offers a variety of features such as zooming, rotating, and scaling images, making it a versatile tool for image manipulation in web applications.
Basic Image Cropping
This feature allows you to crop an image with a specified aspect ratio. The `crop` event provides details about the cropping area, such as its position and dimensions.
const image = document.getElementById('image');
const cropper = new Cropper(image, {
aspectRatio: 16 / 9,
crop(event) {
console.log(event.detail.x);
console.log(event.detail.y);
console.log(event.detail.width);
console.log(event.detail.height);
console.log(event.detail.rotate);
console.log(event.detail.scaleX);
console.log(event.detail.scaleY);
},
});Zooming
This feature allows you to zoom in and out of the image. The `zoom` event provides the current zoom ratio.
const cropper = new Cropper(image, {
zoom(event) {
console.log(event.detail.ratio);
},
});Rotating
This feature allows you to rotate the image by a specified degree. In this example, the image is rotated by 45 degrees.
cropper.rotate(45);Scaling
This feature allows you to scale the image horizontally or vertically. In this example, the image is flipped horizontally.
cropper.scaleX(-1);React Image Crop is a library specifically designed for React applications. It provides similar functionalities to CropperJS, such as image cropping and aspect ratio control. However, it is more tailored for use with React components, making it a better choice for React developers.
Ngx Image Cropper is an Angular library for cropping images. It offers similar features to CropperJS, including aspect ratio control and image manipulation. This package is more suitable for Angular applications, providing a seamless integration with Angular components.
Vue Cropper is a Vue.js component for image cropping. It provides functionalities similar to CropperJS, such as zooming, rotating, and scaling images. This package is designed to work well within Vue.js applications, offering a more native experience for Vue developers.
JavaScript image cropper. This is the branch for v1.x, for v2.x, check out the
v2branch.
dist/
├── cropper.css
├── cropper.min.css (compressed)
├── cropper.js (UMD)
├── cropper.min.js (UMD, compressed)
├── cropper.common.js (CommonJS, default)
└── cropper.esm.js (ES Module)
npm install cropperjs
In browser:
<link href="/path/to/cropper.css" rel="stylesheet">
<script src="/path/to/cropper.js"></script>
cdnjs provides CDN support for Cropper.js's CSS and JavaScript. You can find the links here.
new Cropper(element[, options])
element
HTMLImageElement or HTMLCanvasElementoptions (optional)
Object<!-- Wrap the image or canvas element with a block element (container) -->
<div>
<img id="image" src="picture.jpg">
</div>
/* Make sure the size of the image fits perfectly into the container */
img {
display: block;
/* This rule is very important, please don't ignore this */
max-width: 100%;
}
// import 'cropperjs/dist/cropper.css';
import Cropper from 'cropperjs';
const image = document.getElementById('image');
const cropper = new Cropper(image, {
aspectRatio: 16 / 9,
crop(event) {
console.log(event.detail.x);
console.log(event.detail.y);
console.log(event.detail.width);
console.log(event.detail.height);
console.log(event.detail.rotate);
console.log(event.detail.scaleX);
console.log(event.detail.scaleY);
},
});
How to crop a new area after zooming in or zooming out?
Just double-click your mouse to enter crop mode.
How to move the image after cropping an area?
Just double-click your mouse to enter move mode.
How to fix the aspect ratio in free ratio mode?
Just hold the
Shiftkey when you resize the crop box.
How to crop a square area in free ratio mode?
Just hold the
Shiftkey when you crop on the image.
The size of the cropper inherits from the size of the image's parent element (wrapper), so be sure to wrap the image with a visible block element.
If you are using cropper in a modal, you should initialize the cropper after the modal is shown completely. Otherwise, you will not get the correct cropper.
The outputted cropped data is based on the original image size, so you can use them to crop the image directly.
If you try to start cropper on a cross-origin image, please make sure that your browser supports HTML5 CORS settings attributes, and your image server supports the Access-Control-Allow-Origin option (see the HTTP access control (CORS)).
Known iOS resource limits: As iOS devices limit memory, the browser may crash when you are cropping a large image (iPhone camera resolution). To avoid this, you may resize the image first (preferably below 1024 pixels) before starting a cropper.
Known image size increase: When exporting the cropped image on the browser side with the HTMLCanvasElement.toDataURL method, the size of the exported image may be greater than the original image's. This is because the type of the exported image is not the same as the original image. So just pass the original image's type as the first parameter to toDataURL to fix this. For example, if the original type is JPEG, then use cropper.getCroppedCanvas().toDataURL('image/jpeg') to export image.
You may set cropper options with new Cropper(image, options).
If you want to change the global default options, You may use Cropper.setDefaults(options).
Number00: no restrictions1: restrict the crop box not to exceed the size of the canvas.2: restrict the minimum canvas size to fit within the container. If the proportions of the canvas and the container differ, the minimum canvas will be surrounded by extra space in one of the dimensions.3: restrict the minimum canvas size to fill fit the container. If the proportions of the canvas and the container are different, the container will not be able to fit the whole canvas in one of the dimensions.Define the view mode of the cropper. If you set viewMode to 0, the crop box can extend outside the canvas, while a value of 1, 2, or 3 will restrict the crop box to the size of the canvas. viewMode of 2 or 3 will additionally restrict the canvas to the container. There is no difference between 2 and 3 when the proportions of the canvas and the container are the same.
String'crop''crop': create a new crop box'move': move the canvas'none': do nothingDefine the dragging mode of the cropper.
NumberNaNDefine the initial aspect ratio of the crop box. By default, it is the same as the aspect ratio of the canvas (image wrapper).
Only available when the
aspectRatiooption is set toNaN.
NumberNaNDefine the fixed aspect ratio of the crop box. By default, the crop box has a free ratio.
ObjectnullThe previous cropped data you stored will be passed to the setData method automatically when initialized.
Only available when the
autoCropoption had set to thetrue.
Element, Array (elements), NodeList or String (selector)''Add extra elements (containers) for preview.
Notes:
aspectRatio option, be sure to set the same aspect ratio to the preview container.overflow: hidden style to the preview container.BooleantrueRe-render the cropper when resizing the window.
BooleantrueRestore the cropped area after resizing the window.
BooleantrueCheck if the current image is a cross-origin image.
If so, a crossOrigin attribute will be added to the cloned image element, and a timestamp parameter will be added to the src attribute to reload the source image to avoid browser cache error.
Adding a crossOrigin attribute to the image element will stop adding a timestamp to the image URL and stop reloading the image. But the request (XMLHttpRequest) to read the image data for orientation checking will require a timestamp to bust the cache to avoid browser cache error. You can set the checkOrientation option to false to cancel this request.
If the value of the image's crossOrigin attribute is "use-credentials", then the withCredentials attribute will set to true when read the image data by XMLHttpRequest.
BooleantrueCheck the current image's Exif Orientation information. Note that only a JPEG image may contain Exif Orientation information.
Exactly, read the Orientation value for rotating or flipping the image, and then override the Orientation value with 1 (the default value) to avoid some issues (1, 2) on iOS devices.
Requires to set both the rotatable and scalable options to true at the same time.
Note: Do not trust this all the time as some JPG images may have incorrect (non-standard) Orientation values
Requires Typed Arrays support (IE 10+).
BooleantrueShow the black modal above the image and under the crop box.
BooleantrueShow the dashed lines above the crop box.
BooleantrueShow the center indicator above the crop box.
BooleantrueShow the white modal above the crop box (highlight the crop box).
BooleantrueShow the grid background of the container.
BooleantrueEnable to crop the image automatically when initialized.
Number0.8 (80% of the image)It should be a number between 0 and 1. Define the automatic cropping area size (percentage).
BooleantrueEnable to move the image.
BooleantrueEnable to rotate the image.
BooleantrueEnable to scale the image.
BooleantrueEnable to zoom the image.
BooleantrueEnable to zoom the image by dragging touch.
BooleantrueEnable to zoom the image by mouse wheeling.
Number0.1Define zoom ratio when zooming the image by mouse wheeling.
BooleantrueEnable to move the crop box by dragging.
BooleantrueEnable to resize the crop box by dragging.
BooleantrueEnable to toggle drag mode between "crop" and "move" when clicking twice on the cropper.
Requires
dblclickevent support.
Number200The minimum width of the container.
Number100The minimum height of the container.
Number0The minimum width of the canvas (image wrapper).
Number0The minimum height of the canvas (image wrapper).
Number0The minimum width of the crop box.
Note: This size is relative to the page, not the image.
Number0The minimum height of the crop box.
Note: This size is relative to the page, not the image.
FunctionnullA shortcut to the ready event.
FunctionnullA shortcut to the cropstart event.
FunctionnullA shortcut to the cropmove event.
FunctionnullA shortcut to the cropend event.
FunctionnullA shortcut to the crop event.
FunctionnullA shortcut to the zoom event.
As there is an asynchronous process when loading the image, you should call most of the methods after ready, except setAspectRatio, replace and destroy.
If a method doesn't need to return any value, it will return the cropper instance (
this) for chain composition.
new Cropper(image, {
ready() {
// this.cropper[method](argument1, , argument2, ..., argumentN);
this.cropper.move(1, -1);
// Allows chain composition
this.cropper.move(1, -1).rotate(45).scale(1, -1);
},
});
Show the crop box manually.
new Cropper(image, {
autoCrop: false,
ready() {
// Do something here
// ...
// And then
this.cropper.crop();
},
});
Reset the image and crop box to its initial states.
Clear the crop box.
url:
StringhasSameSize (optional):
BooleanfalseReplace the image's src and rebuild the cropper.
Enable (unfreeze) the cropper.
Disable (freeze) the cropper.
Destroy the cropper and remove the instance from the image.
offsetX:
NumberoffsetY (optional):
NumberoffsetX.Move the canvas (image wrapper) with relative offsets.
cropper.move(1);
cropper.move(1, 0);
cropper.move(0, -1);
x:
Numberleft value of the canvasy (optional):
Numbertop value of the canvasx.Move the canvas (image wrapper) to an absolute point.
NumberZoom the canvas (image wrapper) with a relative ratio.
cropper.zoom(0.1);
cropper.zoom(-0.1);
ratio:
Numberpivot (optional):
Object{ x: Number, y: Number }Zoom the canvas (image wrapper) to an absolute ratio.
cropper.zoomTo(1); // 1:1 (canvasData.width === canvasData.naturalWidth)
const containerData = cropper.getContainerData();
// Zoom to 50% from the center of the container.
cropper.zoomTo(.5, {
x: containerData.width / 2,
y: containerData.height / 2,
});
NumberRotate the image to a relative degree.
Requires CSS3 2D Transforms support (IE 9+).
cropper.rotate(90);
cropper.rotate(-90);
NumberRotate the image to an absolute degree.
scaleX:
Number11 it does nothing.scaleY (optional):
NumberscaleX.Scale the image.
Requires CSS3 2D Transforms support (IE 9+).
cropper.scale(-1); // Flip both horizontal and vertical
cropper.scale(-1, 1); // Flip horizontal
cropper.scale(1, -1); // Flip vertical
Number11 it does nothing.Scale the abscissa of the image.
Number11 it does nothing.Scale the ordinate of the image.
rounded (optional):
Booleanfalsetrue to get rounded values.(return value):
Objectx: the offset left of the cropped areay: the offset top of the cropped areawidth: the width of the cropped areaheight: the height of the cropped arearotate: the rotated degrees of the imagescaleX: the scaling factor to apply on the abscissa of the imagescaleY: the scaling factor to apply on the ordinate of the imageOutput the final cropped area position and size data (based on the natural size of the original image).
You can send the data to the server-side to crop the image directly:
- Rotate the image with the
rotateproperty.- Scale the image with the
scaleXandscaleYproperties.- Crop the image with the
x,y,width, andheightproperties.
ObjectgetData method.Change the cropped area position and size with new data (based on the original image).
Note: This method only available when the value of the
viewModeoption is greater than or equal to1.
Objectwidth: the current width of the containerheight: the current height of the containerOutput the container size data.
Objectleft: the offset left of the imagetop: the offset top of the imagewidth: the width of the imageheight: the height of the imagenaturalWidth: the natural width of the imagenaturalHeight: the natural height of the imageaspectRatio: the aspect ratio of the imagerotate: the rotated degrees of the image if it is rotatedscaleX: the scaling factor to apply on the abscissa of the image if scaledscaleY: the scaling factor to apply on the ordinate of the image if scaledOutput the image position, size, and other related data.
Objectleft: the offset left of the canvastop: the offset top of the canvaswidth: the width of the canvasheight: the height of the canvasnaturalWidth: the natural width of the canvas (read only)naturalHeight: the natural height of the canvas (read only)Output the canvas (image wrapper) position and size data.
const imageData = cropper.getImageData();
const canvasData = cropper.getCanvasData();
if (imageData.rotate % 180 === 0) {
console.log(canvasData.naturalWidth === imageData.naturalWidth);
// > true
}
Objectleft: the new offset left of the canvastop: the new offset top of the canvaswidth: the new width of the canvasheight: the new height of the canvasChange the canvas (image wrapper) position and size with new data.
Objectleft: the offset left of the crop boxtop: the offset top of the crop boxwidth: the width of the crop boxheight: the height of the crop boxOutput the crop box position and size data.
Objectleft: the new offset left of the crop boxtop: the new offset top of the crop boxwidth: the new width of the crop boxheight: the new height of the crop boxChange the crop box position and size with new data.
options (optional):
Objectwidth: the destination width of the output canvas.height: the destination height of the output canvas.minWidth: the minimum destination width of the output canvas, the default value is 0.minHeight: the minimum destination height of the output canvas, the default value is 0.maxWidth: the maximum destination width of the output canvas, the default value is Infinity.maxHeight: the maximum destination height of the output canvas, the default value is Infinity.fillColor: a color to fill any alpha values in the output canvas, the default value is the transparent.imageSmoothingEnabled: set to change if images are smoothed (true, default) or not (false).imageSmoothingQuality: set the quality of image smoothing, one of "low" (default), "medium", or "high".rounded: set true to use rounded values (the cropped area position and size data), the default value is false.(return value):
HTMLCanvasElementNotes:
fillColor option first, if not, the transparent part in the JPEG image will become black by default.Browser support:
Get a canvas drawn from the cropped image (lossy compression). If it is not cropped, then returns a canvas drawn the whole image.
After then, you can display the canvas as an image directly, or use HTMLCanvasElement.toDataURL to get a Data URL, or use HTMLCanvasElement.toBlob to get a blob and upload it to server with FormData if the browser supports these APIs.
Avoid getting a blank (or black) output image, you might need to set the maxWidth and maxHeight properties to limited numbers, because of the size limits of a canvas element. Also, you should limit the maximum zoom ratio (in the zoom event) for the same reason.
cropper.getCroppedCanvas();
cropper.getCroppedCanvas({
width: 160,
height: 90,
});
cropper.getCroppedCanvas({
minWidth: 256,
minHeight: 256,
maxWidth: 4096,
maxHeight: 4096,
});
cropper.getCroppedCanvas({
fillColor: '#fff',
imageSmoothingEnabled: false,
imageSmoothingQuality: 'high',
});
// Upload cropped image to server if the browser supports `HTMLCanvasElement.toBlob`.
// The default value for the second parameter of `toBlob` is 'image/png', change it if necessary.
cropper.getCroppedCanvas().toBlob((blob) => {
const formData = new FormData();
// Pass the image file name as the third parameter if necessary.
formData.append('croppedImage', blob/*, 'example.png' */);
// Use `jQuery.ajax` method for example
$.ajax('/path/to/upload', {
method: 'POST',
data: formData,
processData: false,
contentType: false,
success() {
console.log('Upload success');
},
error() {
console.log('Upload error');
},
});
}/*, 'image/png' */);
NumberChange the aspect ratio of the crop box.
String'none''none', 'crop', 'move'Change the drag mode.
Tips: You can toggle the "crop" and "move" mode by double clicking on the cropper.
This event fires when the target image has been loaded and the cropper instance is ready for operating.
let cropper;
image.addEventListener('ready', function () {
console.log(this.cropper === cropper);
// > true
});
cropper = new Cropper(image);
event.detail.originalEvent:
Eventpointerdown, touchstart, and mousedownevent.detail.action:
String'crop': create a new crop box'move': move the canvas (image wrapper)'zoom': zoom in / out the canvas (image wrapper) by touch.'e': resize the east side of the crop box'w': resize the west side of the crop box's': resize the south side of the crop box'n': resize the north side of the crop box'se': resize the southeast side of the crop box'sw': resize the southwest side of the crop box'ne': resize the northeast side of the crop box'nw': resize the northwest side of the crop box'all': move the crop box (all directions)This event fires when the canvas (image wrapper) or the crop box starts to change.
image.addEventListener('cropstart', (event) => {
console.log(event.detail.originalEvent);
console.log(event.detail.action);
});
event.detail.originalEvent:
Eventpointermove, touchmove, and mousemove.event.detail.action: the same as "cropstart".
This event fires when the canvas (image wrapper) or the crop box is changing.
event.detail.originalEvent:
Eventpointerup, pointercancel, touchend, touchcancel, and mouseup.event.detail.action: the same as "cropstart".
This event fires when the canvas (image wrapper) or the crop box stops changing.
About these properties, see the
getDatamethod.
This event fires when the canvas (image wrapper) or the crop box changes.
Notes:
autoCrop option is set to the true, a crop event will be triggered before the ready event.data option is set, another crop event will be triggered before the ready event.event.detail.originalEvent:
Eventwheel, pointermove, touchmove, and mousemove.event.detail.oldRatio:
Numberevent.detail.ratio:
NumbercanvasData.width / canvasData.naturalWidth)This event fires when a cropper instance starts to zoom in or zoom out its canvas (image wrapper).
image.addEventListener('zoom', (event) => {
// Zoom in
if (event.detail.ratio > event.detail.oldRatio) {
event.preventDefault(); // Prevent zoom in
}
// Zoom out
// ...
});
If you have to use another cropper with the same namespace, just call the Cropper.noConflict static method to revert to it.
<script src="other-cropper.js"></script>
<script src="cropper.js"></script>
<script>
Cropper.noConflict();
// Code that uses other `Cropper` can follow here.
</script>
Please read through our contributing guidelines.
Maintained under the Semantic Versioning guidelines.
1.6.2 (Apr 21, 2024)
FAQs
JavaScript image cropper.
We found that cropperjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."